Get Models

The Get Models operation retrieves a list of the models for an account accessible to the authenticating user.

To perform this operation, send an HTTP GETrequest to:

https://api.boomi.com/mdm/api/rest/v1/<accountID>/models?name=ModelName&publicationStatus=<PublicationStatus>

note

This operation requires the authenticating user to have the MDM - View Models privilege and the API Access privilege.

You can implement requests for this operation in processes using the HTTP Client connector.

Path parameters

accountID
ID of the account

Query parameters

ModelName
(optional) retrieve only models with this name

PublicationStatus
(optional) used to filter models by publication status. These values are valid:

• all — retrieve published and draft models

• draft — retrieve only draft models

• publish — retrieve only published models

Responses

• 200 (OK) The body of the response is XML. The root <mdm:Models> element contains an <mdm:Model> element for each of the account’s models. If a model contains both published and draft versions, <mdm:Models> contains an <mdm:Model> element for each version.

  The <mdm:Model> elements are ordered alphabetically by model name. If a model contains both published and draft versions, the <mdm:Model> element for the published version precedes the <mdm:Model> element for the draft version.

  Each <mdm:Model> element has the following child elements:

  • <mdm:name> — name of the model

  • <mdm:id> — system ID of the model

  • <mdm:publicationStatus> — true in the case of a published model or false in the case of a draft model

  • <mdm:latestVersion> (present only in the case of a published model) — number of the latest published version of the model

  In the following sample response body, it publishes the Account model, the Employee model is a draft, and the Vendor model contains published and draft versions:

  <mdm:Models xmlns:mdm="http://mdm.api.platform.boomi.com/" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <mdm:Model>
          <mdm:name>Account</mdm:name>
          <mdm:id>01234567-89ab-cdef-0123-456789abcdef</mdm:id>
          <mdm:publicationStatus>true</mdm:publicationStatus>
          <mdm:latestVersion>15</mdm:latestVersion>
      </mdm:Model>
      <mdm:Model>
          <mdm:name>Employee</mdm:name>
          <mdm:id>12345678-9abc-def0-1234-56789abcdef0</mdm:id>
          <mdm:publicationStatus>false</mdm:publicationStatus>
      </mdm:Model>
      <mdm:Model>
          <mdm:name>Vendor</mdm:name>
          <mdm:id>23456789-abcd-ef01-2345-6789abcdef01</mdm:id>
          <mdm:publicationStatus>true</mdm:publicationStatus>
          <mdm:latestVersion>3</mdm:latestVersion>
      </mdm:Model>
      <mdm:Model>
          <mdm:name>Vendor</mdm:name>
          <mdm:id>23456789-abcd-ef01-2345-6789abcdef01</mdm:id>
          <mdm:publicationStatus>false</mdm:publicationStatus>
      </mdm:Model>
  </mdm:Models>

• 400 (Bad Request) The authenticating user does not have the API Access and MDM - View Models privileges required for this operation. Sample response body:

  <error>
      <message>The authenticated user does not have access rights to this functionality</message>
  </error>

• 400 (Bad Request) ModelName is not the name of a model in the specified account. Sample response body:

  <error>
      <message>No Models are available</message>
  </error>

• 400 (Bad Request) PublicationStatus is an invalid publication status.

  <error>
     <message>Query parameter publicationStatus must have a value of all, draft, or publish</message>
  </error>

• 403 (Forbidden) Authentication failure. Sample response body:

  <UserMessage id="error.user.login" type="error">
      <Data>Incorrect user name and password combination.</Data>
  </UserMessage>

• 403 (Forbidden) accountID does not identify an account accessible to the authenticating user. Sample response body:

  <UserMessage id="error.user.login" type="error">
      <Data>Incorrect user name and password combination.</Data>
  </UserMessage>